Repository navigation
Conversation
Part of ShisatoYano#199: a short, practical page for chapter 1 covering how to run a simulation from the repository root, what the show_plot flag does, how --save-gif writes the animation of the simulations that define a GIF output, and how run_test_suites.sh checks the environment.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #199 (section 1.2).
What this adds
A new page
doc/getting_started/running_simulations.md, linked from the chapter page, covering the three points the issue lists for this section:src/simulations/, run from the repository root (example: the EKF localization simulation), with what the window and the terminal output show.--save-gif: which simulations write a GIF (about half of them define a GIF output), where the file goes (the simulation's own folder), and that these GIF files are the ones the gallery shows. Example with the Hybrid A* planner.show_plotand the tests: each script keeps its animation behind ashow_plotflag, the tests call eachmain()with the flag off, and. run_test_suites.sh(pytest overtest/) confirms the environment is complete.It follows the writing guide: a search-oriented first sentence, one page per section, no theory layer (the page links to Chapter 2 for the simulator itself). The chapter page's note now says the chapter is being written, and section 1.2 links to the new page, so it is nested under the chapter in the sidebar.
Verification
Section 1.2 was claimed in #199.